﻿#region MIT Licence
/*
 * Copyright (C) 2014 PdfCreative
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
 * and associated documentation files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, 
 * sublicense, and/or sell copies of the Software, and to permit persons to whom 
 * the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included 
 * in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, 
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, 
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#endregion

using System;
using System.Collections.Generic;
using System.Text;

namespace PdfCreative.Pdf.Graphics.Tables
{
    /// <summary>
    /// The Column class represents a column in a table. It is used to set the number of
    /// columns in a table, and optionally fix their widths.
    /// </summary>
    public class Column
    {
        // Private fields
        // ==============
        #region Private fields
        private float? _width;                     // The column width.
        #endregion



        // Public properties
        // =================
        #region Public properties
        /// <summary>
        /// Sets or retrieves the column's optional width. This is a nullable field.
        /// When Width is set to a null reference, the column width is determined by
        /// cell content.
        /// For fixed width, the value must be non-negative.
        /// </summary>
        public float? Width
        {
            get { return _width; }
            set
            {
                if (value.HasValue && value.Value < 0)
                    throw new ArgumentOutOfRangeException(
                        "value", "Width must be zero or a positive number, or a null reference.");

                _width = value;
            }
        }
        #endregion



        // Public constructor
        // ==================
        #region Public constructor
        /// <summary>
        /// Constructs a new Column instance.
        /// </summary>
        public Column() : this(null) { }

        /// <summary>
        /// Constructs a new Column instance with the specified width.
        /// </summary>
        /// <param name="width">The width of the column. For a column with a fixed width,
        /// specify a non-negative value. For a column with variable width,
        /// pass a null reference.</param>
        public Column(float? width)
        {
            this.Width = width;
        }
        #endregion

    } // Column class
}
